home *** CD-ROM | disk | FTP | other *** search
/ Internet Info 1994 March / Internet Info CD-ROM (Walnut Creek) (March 1994).iso / networking / info-service / gopher / VieGOPHER / rose.doc < prev    next >
Encoding:
Text File  |  1993-06-16  |  5.7 KB  |  140 lines
  1.  
  2. FILE ROSE.DOC
  3.  
  4. written:       1992-10-08 <Gerhard.Gonter@wu-wien.ac.at>
  5. latest update: 1993-05-15
  6.  
  7. Note: You guess it, the file is still not very complete ...
  8.  
  9. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  10. Introduction and Overview:
  11.  
  12. This file describes the installation procedure ROSE and the format of
  13. files used as the basis for the installation.  The files that are read
  14. are a PRODUCT file and an optional FIX file.  The PRODUCT file contains
  15. all necessary information from the author of the product with all
  16. pre-defined options and help information for the installer.  The
  17. optional FIX file is used to read values for installation parameters
  18. that where used in an earlier installation rundown.  Typically, the
  19. author distributes a PRODUCT file and no FIX file.  Under some
  20. circumstances it might be useful to distribute a set of pre-defined
  21. FIX files together with the PRODUCT file.
  22.  
  23.  
  24. ------------------------
  25. Operation:
  26.  
  27. To install a product using ROSE enter the following command:
  28.    ROSE productname
  29.  
  30. The product name is the name of a PRODUCT file, e.g. if you received
  31. VieGOPHER, then enter:
  32.    ROSE VIEGOPHR
  33.  
  34. When running down the PRODUCT file, ROSE will occasionally prompt you
  35. for selection options.  They are usually presented like this:
  36.  
  37.   +-------------------------------------------------------------+
  38.   |             (... some other text ...)                       |
  39.   |*****************************************************        |
  40.   |The variable XYZ is used to do ...                           |
  41.   |Allowed values are ABC, DEF or GHI.                          |
  42.   |The predefined value is GHI.                                 |
  43.   |---------                                                    |
  44.   |1. use predefined value: GHI                                 |
  45.   |2. use fixed value:                                          |
  46.   |3. enter new value                                           |
  47.   |X. stop                                                      |
  48.   +-------------------------------------------------------------+
  49.  
  50. At this point you can select between the options by entering the
  51. code shown in the menu:
  52. 1. The predefined value, that is the value that is defined in the
  53.    PRODUCT file in a #set statement.
  54. 2. The fixed value, that is the value which was used in the last
  55.    ROSE run-down.  That particular value was loaded from the
  56.    FIX file.
  57. 3. A new value.  When this code is selected enter the new value
  58.    that you want to use in your installation on the input line.
  59. X. ... to abort the installation process immediately.
  60.  
  61. For convenience, two short hand entries are possible:
  62. -  Hitting ENTER alone means to use the predefined value.
  63.    This is equivalent to option 1.
  64. -  Entering anything other than 1, 2, 3, X, x or just ENTER
  65.    means that this value is used a new fix value.
  66.    This is equivalent to option 3.
  67.  
  68.  
  69. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  70. The PRODUCT file:
  71.  
  72. Basically, the PRODUCT file contains information for generating the
  73. production modules and formatting information that is used for preparing
  74. the source listing.
  75.  
  76.  
  77. Syntax:
  78.  
  79. Lines starting with a # sign are treated as ROSE commands, however
  80. text lines starting with a # sign in column 1 can be generated by
  81. adding an extra # sign in front to the line.
  82.  
  83. general syntax:
  84. #command parameters     ROSE command with optional parameters
  85. # comment               commented text, not to be included
  86.                         in the module generated.
  87. ##line                  text line written as #line
  88. #end                    end of product data, processors should not read
  89.                         beyond this statement.
  90.  
  91. 1. commands relevant for documentation
  92. #section <text>         generates a LaTeX section
  93. #subsection <text>      generates a LaTeX subsection
  94. #subsubsection <text>   generates a LaTeX subsubsection
  95. #paragraph <text>       generates a LaTeX paragraph
  96. #verbatim               introduces a LaTeX block
  97. #endverbatim            ends a LaTeX block
  98. #v <text>               verbose text, one line
  99. #organize <rose> <latex> <text>         /*not used*/
  100.  
  101. 2. commands relevant for code generation
  102.  
  103. 2.a. conditional output generation
  104. #switch <id>            conditional output generation depending on
  105.                         the value of the variable <id>
  106. #case <val>             output generated if variable <id> has value <val>
  107. #default                output is generated if no #case matched
  108. #endswitch              end of a conditional output generation section
  109.  
  110. 2.b. file handling
  111. #erase <filename>       erase the named file
  112. #module <filename>(opt  append generated output to the named file
  113.                         possible options:
  114.                         FIX: the file is written with fixed records
  115.                              and line numbers
  116.  
  117. 2.c. interaction
  118. #help <id>              begin of help text for a variable <id>
  119. #endhelp
  120. #set <id> <val>         set variable <id> to the value <val>
  121. #prompt <id> <val>*     prompt for fix value for <id>
  122.                         if values (<val>*) are specified, the input
  123.                         is verified against them and only values from
  124.                         the list are accepted.
  125. #call <pgm> <id>*       call the program <pgm> and replace macros
  126.                         for 0 or more ROSE variables <id>.
  127.  
  128. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  129. Remarks:
  130. The program's name origins from Rose Nylund and does *not* mean anything
  131. fancy like 'REXX Output Synthesizer Engine' but I wouldn't mind if anyone
  132. prefers the second version.
  133.  
  134.  
  135. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  136. To-Do list:
  137. +  hooks: include sections of code provieded by the user
  138. +  suppress option for fixed value if there is none
  139. +  check out option for fixed record length option
  140.